nodemailer

What is nodemailer?

Nodemailer is a module for Node.js applications to allow easy email sending. It supports various transport methods and has a simple setup process for sending emails.

What are nodemailer's main functionalities?

Send Emails

This feature allows you to send emails using Nodemailer. The code sample shows how to set up a transporter using Gmail, define mail options, and send an email.

const nodemailer = require('nodemailer');

let transporter = nodemailer.createTransport({
  service: 'gmail',
  auth: {
    user: '[e-mail]',
    pass: 'yourpassword'
  }
});

let mailOptions = {
  from: '[e-mail]',
  to: '[e-mail]',
  subject: 'Test Email Subject',
  text: 'Hello world?',
  html: '<b>Hello world?</b>'
};

transporter.sendMail(mailOptions, function(error, info){
  if (error) {
    console.log(error);
  } else {
    console.log('Email sent: ' + info.response);
  }
});

HTML Email Content

Nodemailer allows you to send HTML content in your emails. The code sample demonstrates how to send an email with HTML content.

const nodemailer = require('nodemailer');

let transporter = nodemailer.createTransport({
  // transport configuration
});

let mailOptions = {
  from: '[e-mail]',
  to: '[e-mail]',
  subject: 'HTML Email',
  html: '<h1>Welcome</h1><p>That was easy!</p>'
};

transporter.sendMail(mailOptions, function(error, info){
  // callback
});

Attachments

Nodemailer supports sending attachments in emails. The code sample shows how to attach a file to an email.

const nodemailer = require('nodemailer');

let transporter = nodemailer.createTransport({
  // transport configuration
});

let mailOptions = {
  from: '[e-mail]',
  to: '[e-mail]',
  subject: 'Attachment',
  text: 'Please find the attachment.',
  attachments: [
    {
      filename: 'file.txt',
      path: '/path/to/file.txt'
    }
  ]
};

transporter.sendMail(mailOptions, function(error, info){
  // callback
});

Custom Transport Methods

Nodemailer allows the use of custom transport methods for sending emails. The code sample illustrates how to use a custom transport plugin.

const nodemailer = require('nodemailer');
const customTransport = require('my-custom-transport');

let transporter = nodemailer.createTransport(customTransport({
  // custom transport options
}));

// send mail with defined transport object
transporter.sendMail({
  // mail options
}, function(error, info){
  // callback
});

Other packages similar to nodemailer

mailgun-js

A simple Node.js module for Mailgun. Mailgun-js is designed to work with the Mailgun API for sending, receiving, and tracking emails. It's similar to Nodemailer in functionality but is specifically tailored for Mailgun's service.

postmark

The official Node.js client library for interacting with the Postmark API. This package is intended for sending emails through Postmark's transactional email service. Unlike Nodemailer, which is more generic, Postmark is focused on providing a robust service for transactional emails.

aws-sdk

Amazon Web Services SDK for JavaScript in Node.js. It includes support for SES (Simple Email Service), which can be used to send emails. While Nodemailer is a standalone package for email, aws-sdk is a comprehensive cloud services SDK that includes email sending capabilities among many other AWS services.

README

Send e-mails from Node.js – easy as cake! 🍰✉️

Community version

This is the community version of Nodemailer (usage docs). Community meaning minimal maintenance and support by the author.

For an upgraded and up to date Nodemailer PRO see nodemailer.com homepage.

---

The Nodemailer logo was designed by Sven Kristjansen.